tooling: Add GitHub issue and PR templates.#225
Conversation
There was a problem hiding this comment.
Pull request overview
Adds standardized GitHub contribution templates to make incoming issues/PRs more consistent and to remind contributors of the project’s local/CI checks.
Changes:
- Added three GitHub issue form templates (bug report, feature request, documentation).
- Added an issue template
config.ymlto disable blank issues and add a contact link. - Added a pull request template with a contributor checklist.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| .github/ISSUE_TEMPLATE/bug_report.yml | New issue form to capture reproducible bug reports (component dropdown, environment, logs). |
| .github/ISSUE_TEMPLATE/feature_request.yml | New issue form for feature requests including proposed API usage. |
| .github/ISSUE_TEMPLATE/documentation.yml | New issue form for documentation gaps/improvements. |
| .github/ISSUE_TEMPLATE/config.yml | Disables blank issues and adds a STeaMi website contact link. |
| .github/PULL_REQUEST_TEMPLATE.md | Adds a PR template with summary/changes sections and a checklist. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Checklist | ||
|
|
||
| - [ ] `ruff check` passes | ||
| - [ ] `pytest tests/ -k mock` passes (no mock test broken) |
There was a problem hiding this comment.
The checklist test command here differs from the documented/CI invocation (which uses python -m pytest ... -v). Using the same command as CI/README/CONTRIBUTING reduces confusion and ensures the same test selection/verbosity is exercised locally.
| - [ ] `pytest tests/ -k mock` passes (no mock test broken) | |
| - [ ] `python -m pytest tests/ -k mock -v` passes (no mock test broken) |
There was a problem hiding this comment.
Fixed in 04e52f7. Changed to python -m pytest tests/ -k mock -v to match CI invocation.
| @@ -0,0 +1,67 @@ | |||
| name: Feature Request | |||
| description: Suggest a new feature or improvement. | |||
| title: "<driver>: <short description>" | |||
There was a problem hiding this comment.
The issue title format asks for <driver>: ..., but the component dropdown includes non-driver values like Project-wide and New driver. Consider changing the suggested title pattern (or dropdown values) so reporters don't end up with mismatched titles for project-wide requests.
| title: "<driver>: <short description>" | |
| title: "<component>: <short description>" |
There was a problem hiding this comment.
Fixed in 04e52f7. Changed <driver> to <component> in both bug_report.yml and feature_request.yml title patterns to cover non-driver values like 'Project-wide'.
|
🎉 This PR is included in version 0.0.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Summary
Closes #202
Add 3 issue templates (bug report, feature request, documentation) and 1 PR template to standardize contributions.
Changes
.github/ISSUE_TEMPLATE/bug_report.yml— Form-based bug report with driver dropdown, environment, logs.github/ISSUE_TEMPLATE/feature_request.yml— Feature request with proposed API code block.github/ISSUE_TEMPLATE/documentation.yml— Documentation improvement request.github/ISSUE_TEMPLATE/config.yml— Disable blank issues, add STeaMi website link.github/PULL_REQUEST_TEMPLATE.md— PR checklist (ruff, pytest, hardware, README, commits)Checklist
ruff checkpassespytest tests/ -k mockpasses (no mock test broken)<scope>: <Description.>format